Walkthrough #1709
Walkthrough #1709
Conversation
Adds a walkthrough to the package.json that guides users through: - Installing Swift - Creating a New Project - Extension Commands - Running Tests - Selecting a Toolchain
Add some GIFs and additional steps for running, debugging and DocC previewing. Issue: swiftlang#1560
|
|
||
|  | ||
|
|
||
| When you open an existing project with a ``Package.swift`` file the extension will start automatically. |
There was a problem hiding this comment.
I wonder if open could be its own walkthrough where you could show the explorer with Package.swift in it and the swift package resolve task getting kicked off. Sort of visual image to know it's working.
If we split that to a separate walkthrough, could mention the prompt to open in new window OR add to workspace as a way to link to the multi-root workspace documentation for vscode.
There was a problem hiding this comment.
Yeah I originally had it as a separate step, but we didn't want to put too many steps in the walkthrough to intimidate the users so just put it briefly here in this step. Could add a longer GIF maybe showing a package resolve for a larger project, smaller projects load too quickly to see what's happening.
- Add additional pictures to clarify certain instructions - Update the GIFs for testing view and DocC preview - Ensure that each step has a unique completion action to ensure that the checkbox is only checked after that step is viewed
Description
Add some GIFs and additional steps for running, debugging and DocC previewing to the walkthrough created by @plemarquand.
Issue: #1560
Tasks